Index...
Centrallix Documentation
|
Common Properties
Common_Properties :: A list of common properties used by many report components
Metadata:
| type: | Common Properties |
| visual: | no |
| container: | no |
Overview:
Below is a list of common properties that many report writer components have.
Visual positioning properties such as x, y, width, height are shared by areas, images, and tables.
The margin settings margintop, marginbottom, marginleft, and marginright are shared by the system/report object as well as areas, tables, table rows, and table cells.
Formatting settings such as style, font, fontsize, fontcolor, align, and lineheight are shared by nearly all objects except for images and queries.
Data output properties, including dateformat, moneyformat, and nullformat, are shared by all objects except for images and queries.
The 'condition' property is available on all objects except for system/report and report/table-cell.
Border properties are available on areas, tables, and table-rows.
Usage:
Properties:
| Property | Type | Description |
|---|
| align |
string |
The text alignment to use - either "left" (default), "center", "right", or "full". Available on all objects except image, query, and parameter. |
| bottomborder |
double |
Width of the outside border at the bottom of the table, table-row, or area. |
| condition |
integer |
Typically an expression that evaluates to an integer/boolean type. If true, the area, table, table-row, image, or data element is displayed, otherwise the object (and any contents) are ignored. |
| dateformat |
string |
If the field has a date/time data type, this allows the format to be specified. See the introduction to the reporting system documentation for date/time format information. Available on all objects except image, query, and parameter. |
| font |
string |
The font to use. Available fonts are "times", "helvetica", and "courier". Available on all objects except image, query, and parameter. |
| fontsize |
integer |
The font size in points. Available on all objects except image, query, and parameter. |
| fontcolor |
string |
The color to use for the font, in HTML RGB format such as "#FF0000" for Red. Available on all objects except image, query, and parameter. |
| height |
double |
The height of the area, image, or table. If "fixedsize" is set to "no" (false), then the object is allowed to grow beyond this height. |
| leftborder |
double |
Width of the outside border at the left side of the table, table-row, or area. |
| lineheight |
double |
The line height (and thus line spacing) to use. Normally this is set when "fontsize" is set, but can be manually set. Units are standard "y" units, so setting this to 2.0 will not result in double-spaced lines. Available on all objects except image, query, and parameter. |
| margintop |
double |
The height of the top margin of the object. Default 0. Available on report, area, table, table-row, and table-cell. |
| marginbottom |
double |
The height of the bottom margin. Default 0. Available on report, area, table, table-row, and table-cell. |
| marginleft |
double |
The width of the left margin. Default 0. Available on report, area, table, table-row, and table-cell. |
| marginright |
double |
The width of the right margin. Default 0. Available on report, area, table, table-row, and table-cell. |
| moneyformat |
string |
If the field has a money data type, this allows the format to be specified. See the introduction to the reporting system documentation for money format information. Available on all objects except image, query, and parameter. |
| nullformat |
string |
Sets the text to use if the data is NULL. Normally "NULL" is displayed. Available on all objects except image, query, and parameter. |
| rightborder |
double |
Width of the outside border at the right side of the table, table-row, or area. |
| style |
stringvec |
A list of styles, separated by commas. Values include "bold", "italic", "underline", or "plain". Available on all objects except image, query, and parameter. |
| topborder |
double |
Width of the outside border at the top of the table, table-row, or area. |
| width |
double |
The width of the table, area, or image. |
| x |
double |
The X coordinate of the upper left corner of the table, area, or image, relative to the container. Defaults to 0.0. |
| y |
double |
The Y coordinate of the upper left corner of the table, area, or image, relative to the container. Defaults to 0.0. |
Comments...
(none yet)
Add a Comment...
|
